/*
 * Copyright 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.benchmark

import android.util.Log
import androidx.annotation.RestrictTo

/**
 * Actions that need to be performed once per test suite are defined in this [RunListenerDelegate].
 *
 * This way, we minimize the costs of these suite wide actions, and benchmarks continue running fast
 * (with minimal additional overheads).
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
class RunListenerDelegate(private val sideEffects: List<SideEffect>) {
    /** Called before any tests have been run. */
    fun onTestRunStarted() {
        sideEffects.forEach { sideEffect ->
            Log.d(BenchmarkState.TAG, "Setting up side effect ${sideEffect.name()}")
            sideEffect.setup()
        }
    }

    /** Called after all tests have been completed. */
    fun onTestRunFinished() {
        sideEffects.forEach { sideEffect ->
            Log.d(BenchmarkState.TAG, "Tearing down side effect ${sideEffect.name()}")
            sideEffect.tearDown()
        }
    }
}
